Boleto
Pagamento de Boleto
📘Siga este link para informações sobre pagamento de boletos: Pagamento de Boletos
Tipos de cobrança
A lista abaixo apresenta os Tipos de Cobrança no Delfinance
BANKSLIP: Boleto bancário convencional
BANKSLIP_PIX: Boleto bancário que contém um QR Code e também pode ser pago usando um método de pagamento Pix
IMPORTANTE: Antes de criar Cobranças do tipo BANKSLIP
e BANKSLIP_PIX
, será necessário configurar a conta bancária como Emissora de Boleto Bancário Autorizada ou em pt-BR “Cedente”. Observe também que é recomendado usar GUID como correlationId
Você pode solicitar esse ajuste falando com nossa Equipe Operacional pelo e-mail: [email protected].
Especificações Técnicas Gerais
Esta seção tem como objetivo destacar e explicar elementos técnicos comuns a todas as operações/processos.
Além do processo de Autenticação explicado acima, para requisições HTTP, alguns campos que envolvem regras de negócio ou especificações gerais do Delfinance BaaS se destacam.
Abaixo estão alguns campos presente no body de requisições que merecem uma explicação adicional.
type
- Tipo de Cobrança, anteriormente apresentado, que neste caso deve ser atribuído o valorBANKSLIP
;correlationId
- corresponde a um identificador que garante a exclusividade daquele Cobrança internamente a um sistema. Este campo reflete o controle interno usado no sistema da entidade que consome esta API, que é, o cliente.ourNumber
- você corresponde a um identificador ** para Delfinance ** que permite o monitoramento ou rastreamento de um Cobrança. Este valor será exibido/registrado no Faturamento, e normalmente é apresentado como “Nosso Número”;yourNumber
- corresponde a um identificador para o issuer da cobrança, que permite o monitoramento ou rastreamento da cobrança. Este valor também será exibido/registrado na cobrança e será apresentado como “Número do Documento”/ “N° do Documento”.
Delfinance entende que os outros campos não apresentam grandes complexidades ou regras específicas a serem seguidas.
Criação
Criando uma cobrança convencional
Método POST
<https://apisandbox.delbank.com.br/baas/v1/charges>
A Cobrança Normal tem como foco o Título Simplificado que irá refletir na Carteira 112.
Note*: Wallet é a maneira que você escolhe emitir o seu booleto. Existem dois tipos de wallet disponíveis: wallet 112 e wallet 121.
Na categoria de cobrança atual, não é necessário enviar o campo ourNumber, já que a criação dele é uma responsabilidade do Delfinance.
Header da requisição e corpo (body)
Headers
Nome | Descrição |
---|---|
x-delbank-api-key | Obrigatório. Chave de API |
x-delfinance-account-id | Obrigatório. O número da conta Delfinance. |
{
"type": "BANKSLIP",
"correlationId": "CORRELATIONID",
"yourNumber": "SEUNUMERO",
"dueDate": "yyyy-mm-dd",
"Amount": 0.1,
"payer": {
"name": "fullname",
"document": "document",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
}
}
Header da resposta e corpo (body)
Content-Type: application/json
{
"type": "BANKSLIP",
"amount": 0.1,
"yourNumber": "SEUNUMERO",
"ourNumber": "00000215634",
"correlationId": "68757f64-486c-41dc-b036-4e8cb5e62576",
"dueDate": "2023-04-01",
"barCode": "43596930700000000100001112000000600000215634",
"digitableLine": "43590001161200000060900002156347693070000000010",
"payer": {
"name": "FULANO CICLANO DA SILVA BELTRANO",
"document": "9999999999",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV. RIO BRANCO",
"neighborhood": "CENTRO",
"number": "186",
"complement": "SALA 602",
"city": "ARACAJU",
"state": "SE"
}
},
"status": "Pending",
"updatedAt": "2022-12-07T18:16:47.347Z",
"createdAt": "2022-12-07T18:16:47.347Z"
}
Obs.: Solicitações malsucedidas responderão com seu respectivo código HTTP e o seguinte Corpo:
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-fa5995742bd8906dfbaf6315d1d57d9e-e8c2cf5c14f5099f-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 4 | BytePositionInLine: 25."
]
}
}
Criar uma cobrança expressa
HTTP POST
<https://apisandbox.delbank.com.br/baas/v1/charges>
A cobrança expressa tem como foco o título gerado pelo cliente, que será refletido em "Carteira 121"*.
OBS.*: A carteira é a forma que você escolher para emitir seu boleto bancário. Existem dois tipos de carteiras disponíveis: carteira 112 e carteira 121.
Diferentemente das cobranças convencionais, neste tipo de cobrança é necessário o envio do campo "ourNumber".
Abaixo seguem instruções e um modelo para realização desta operação.
Headers
Nome | Descrição |
---|---|
x-delbank-api-key | Obrigatório. Chave de API |
x-delfinance-account-id | Obrigatório. O número da conta Delfinance. |
{
"type": "BANKSLIP",
"correlationId": "CORRELATIONID",
"yourNumber": "SEUNUMERO",
"ourNumber": "00160860733",
"dueDate": "yyyy-mm-dd",
"Amount": 0.1,
"payer": {
"name": "fullname",
"document": "document",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
}
}
Header da resposta e corpo (body)
Content-Type: application/json
{
"type": "BANKSLIP",
"amount": 0.1,
"yourNumber": "SEUNUMERO2",
"ourNumber": "00160860733",
"correlationId": "72b8e755-f620-4667-872f-529a87098d07",
"dueDate": "2023-04-01",
"barCode": "43591930700000000100001121000000600160860733",
"digitableLine": "43590001162100000060001608607337193070000000010",
"payer": {
"name": "FULANO CICLANO DA SILVA BELTRANO",
"document": "9999999999",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV. RIO BRANCO",
"neighborhood": "CENTRO",
"number": "186",
"complement": "SALA 602",
"city": "ARACAJU",
"state": "SE"
}
},
"status": "Pending",
"updatedAt": "2022-12-07T21:28:39.663Z",
"createdAt": "2022-12-07T21:28:39.663Z"
}
Obs.: Requisições com falha terão o seguinte HTTP e corpo:
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-5d3f8bf7082b9428d8461b504dae9fc0-84ffab015d792b9f-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 5 | BytePositionInLine: 25."
]
}
}
Criando um Título com Fiador/Sacador
HTTP POST
<https://apisandbox.delbank.com.br/baas/v1/charges>
Este endpoint é usado para criar um Título, "Boleto bancário" (BANKSLIP) ou "Boleto bancário pix" (BANKSLIP_PIX) com um Fiador/Sacador (Beneficiário Final).
Headers
Nome | Descrição |
---|---|
x-delbank-api-key | Obrigatório. Chave de API |
x-delfinance-account-id | Obrigatório. O número da conta Delfinance. |
{
"type": "BANKSLIP",
"correlationId": "CORRELATIONID",
"yourNumber": "SEUNUMERO",
"ourNumber": "00160860733",
"dueDate": "yyyy-mm-dd",
"Amount": 0.1,
"payer": {
"name": "fullname",
"document": "document",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
},
"finalBeneficiary": {
"name": "fullname",
"document": "document",
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
}
}
Header da resposta e corpo (body)
Content-Type: application/json
{
"type": "BANKSLIP",
"amount": 0.1,
"yourNumber": "SEUNUMERO2",
"ourNumber": "00160860733",
"correlationId": "72b8e755-f620-4667-872f-529a87098d07",
"dueDate": "2023-04-01",
"barCode": "43591930700000000100001121000000600160860733",
"digitableLine": "43590001162100000060001608607337193070000000010",
"payer": {
"name": "FULANO CICLANO DA SILVA BELTRANO",
"document": "9999999999",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV. RIO BRANCO",
"neighborhood": "CENTRO",
"number": "186",
"complement": "SALA 602",
"city": "ARACAJU",
"state": "SE"
}
},
"status": "Pending",
"updatedAt": "2022-12-07T21:28:39.663Z",
"createdAt": "2022-12-07T21:28:39.663Z"
}
Obs.: Requisições com falha terão o seguinte HTTP e corpo:
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-3d4d68882c19524d921cc791e2a5e7ee-166c8e241265c3d3-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 6 | BytePositionInLine: 25."
]
}
}
Criando um Título com Fiador/Sacador
HTTP POST
<https://apisandbox.delbank.com.br/baas/v1/charges>
Este endpoint é utilizado para criar uma Cobrança do tipo "Boleto Bancário Pix". Nesta modalidade, o **Título **será emitido na Carteira 112
Header da requisição e corpo (body)
Headers
Nome | Descrição |
---|---|
x-delbank-api-key | Obrigatório. Chave de API |
x-delfinance-account-id | Obrigatório. O número da conta Delfinance. |
{
"type": "BANKSLIP_PIX",
"yourNumber": "SEUNUMERO",
"correlationId": "72b8e755-f620-4667-872f-529a87098d07",//uid único para cada request
"dueDate": "yyyy-mm-dd",
"Amount": 0.1,
"payer": {
"name": "fullname",
"document": "document",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "yyyy-mm-dd",
"amount": 0.01
},
{
"date": "yyyy-mm-dd",
"amount": 0.01
},
{
"date": "yyyy-mm-dd",
"amount": 0.01
}
]
},
"lateFine": {
"type": "Percentage",
"date": "yyyy-mm-dd",
"amount": 2.5
},
"latePayment": {
"type": "Fixed",
"date": "yyyy-mm-dd",
"amount": 2.5
}
}
Header da resposta e corpo (body)
Content-Type: application/json
{
"type": "BANKSLIP_PIX",
"correlationId": "69577abe-3867-4e0b-85ee-21aa6bc9db9b",
"amount": 0.1,
"walletNumber": "112",
"yourNumber": "SEUNUMERO",
"ourNumber": "00000532665",
"dueDate": "2025-06-05T23:59:59.999Z",
"qrCode": "00020101021226770014br.gov.bcb.pix2555pix-h.delbank.com.br/v2/cobv/vcharge00000000000003246005204000053039865802BR5907DELBANK6004CITY62070503***63045ED1",
"qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSU",
"barCode": "43599110300000000100001112000001700000532665",
"digitableLine": "43590001161200000170600005326657911030000000010",
"payer": {
"name": "fullname",
"document": "12345678910",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "2025-03-01T00:00:00Z",
"amount": 0.01
},
{
"date": "2025-03-02T00:00:00Z",
"amount": 0.01
},
{
"date": "2025-03-03T00:00:00Z",
"amount": 0.01
}
]
},
"lateFine": {
"type": "Percentage",
"date": "2025-07-03T00:00:00Z",
"amount": 2.5
},
"latePayment": {
"type": "Fixed",
"date": "2025-07-01T00:00:00Z",
"amount": 2.5
},
"status": "Pending",
"payments": [],
"additionalInfo": [
{
"key": "YourNumber",
"value": "SEUNUMERO"
},
{
"key": "OurNumber",
"value": "00000532665"
},
{
"key": "DigitableLine",
"value": "43590001161200000170600005326657911030000000010"
}
],
"updatedAt": "2025-02-05T20:59:25.0161344Z",
"createdAt": "2025-02-05T20:59:24.0194394Z"
}
Obs.: Requisições com falha terão o seguinte HTTP e corpo:
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-61a3e8c33796e9a3ff0af8052db87afc-ea172db465a74b7f-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 4 | BytePositionInLine: 25."
]
}
}
Criando um Título com desconto, multa e atraso no pagamento
HTTP POST
<https://apisandbox.delbank.com.br/baas/v1/charges>